CLI to streamline programmatic workflows with Sift's API

Usage: sift_cli [OPTIONS] <COMMAND>

Commands:
  config       Manage Sift CLI configuration
  completions  Manage shell autocompletions
  export       Export asset/run data from Sift
  import       Import time series files into Sift
  help         Print this message or the help of the given subcommand(s)

Options:
      --profile <PROFILE>  The profile to use
      --disable-tls        Disable TLS for non-cloud Sift environments
  -h, --help               Print help
  -V, --version            Print version

Manage shell autocompletions

Usage: sift_cli completions [OPTIONS] <COMMAND>

Commands:
  print   Print completions for your shell
  update  Attempts to automatically update this CLI's completions file for the current shell
  help    Print this message or the help of the given subcommand(s)

Options:
      --profile <PROFILE>  The profile to use
      --disable-tls        Disable TLS for non-cloud Sift environments
  -h, --help               Print help

Export asset/run data from Sift

Usage: sift_cli export [OPTIONS] <COMMAND>

Commands:
  run    Export data for a run
  asset  Export data for an asset
  help   Print this message or the help of the given subcommand(s)

Options:
      --profile <PROFILE>  The profile to use
      --disable-tls        Disable TLS for non-cloud Sift environments
  -h, --help               Print help

Export data for a run

Usage: sift_cli export run [OPTIONS] --output <OUTPUT> --format <FORMAT>

Options:
  -n, --name <NAME>                    The name of the run
  -r, --run-id <RUN_ID>                The ID of the run
  -k, --client-key <CLIENT_KEY>        The client key of the run
  -o, --output <OUTPUT>                The file to generate
  -f, --format <FORMAT>                File format for the output file [possible values: csv, sun]
      --profile <PROFILE>              The profile to use
      --disable-tls                    Disable TLS for non-cloud Sift environments
  -x, --channel-regex <CHANNEL_REGEX>  Regular expression used to filter channels to include in the export
  -c, --channel <CHANNEL>              Name of channel to include in the export; can be specified multiple times
      --channel-id <CHANNEL_ID>        ID of channel to include in the export; can be specified multiple times
      --start <START>                  Start time in RFC 3339 format (required for asset exports)
      --stop <STOP>                    Stop time in RFC 3339 format (required for asset exports)
  -h, --help                           Print help

Export data for an asset

Usage: sift_cli export asset [OPTIONS] --output <OUTPUT> --format <FORMAT> <ASSET>

Arguments:
  <ASSET>  The name of the asset

Options:
  -o, --output <OUTPUT>                The file to generate
  -f, --format <FORMAT>                File format for the output file [possible values: csv, sun]
  -x, --channel-regex <CHANNEL_REGEX>  Regular expression used to filter channels to include in the export
  -c, --channel <CHANNEL>              Name of channel to include in the export; can be specified multiple times
      --channel-id <CHANNEL_ID>        ID of channel to include in the export; can be specified multiple times
      --profile <PROFILE>              The profile to use
      --disable-tls                    Disable TLS for non-cloud Sift environments
      --start <START>                  Start time in RFC 3339 format (required for asset exports)
      --stop <STOP>                    Stop time in RFC 3339 format (required for asset exports)
  -h, --help                           Print help

Manage Sift CLI configuration

Usage: sift_cli config [OPTIONS] <COMMAND>

Commands:
  show    Display the contents of the current config file
  where   Show the path to the current config file
  create  Create a new config file (fails if one already exists)
  update  Update fields in the existing config file
  help    Print this message or the help of the given subcommand(s)

Options:
      --profile <PROFILE>  The profile to use
      --disable-tls        Disable TLS for non-cloud Sift environments
  -h, --help               Print help

Import a CSV file into Sift. Unless manually specified all columns are inferred to type string or double

Usage: sift_cli import csv [OPTIONS] --asset <ASSET> <PATH>

Arguments:
  <PATH>  Path to the CSV file to import

Options:
  -a, --asset <ASSET>                        Name of the asset this data belongs to
  -r, --run <RUN>                            Optional run name to associate with this import
      --header-row <HEADER_ROW>              Row number containing column headers (1-based) [default: 1]
      --profile <PROFILE>                    The profile to use
      --disable-tls                          Disable TLS for non-cloud Sift environments
      --first-data-row <FIRST_DATA_ROW>      Row number where data starts (1-based) [default: 2]
  -c, --channel-column <CHANNEL_COLUMN>      1-based column indices to override; can appear multiple times
  -d, --data-type <DATA_TYPE>                Data type for each channel in `--channel-column`. Use `"infer"` to have the program infer the data type which
                                             is useful when wanting to just specify `--unit` and/or `--description` [possible values: infer, double,
                                             string, enum, bit-field, bool, float, int32, uint32, int64, uint64, bytes]
  -u, --unit <UNIT>                          Unit for each channel in `--channel-column` (can be empty)
  -n, --description <DESCRIPTION>            Description for each channel in `--channel-column` (can be empty)
  -e, --enum-config <ENUM_CONFIG>            Enum configuration pairs `<key,name>` (e.g. `"0,start|1,stop"`) for enum-type channels
  -b, --bit-field-config <BIT_FIELD_CONFIG>  Bit-field configuration triplets `<name,index,length>` (e.g. `"12v,0,4|led,4,4"`)
  -t, --time-column <TIME_COLUMN>            1-based index of the time column [default: 1]
  -f, --time-format <TIME_FORMAT>            Time format used in the file [default: absolute-rfc3339] [possible values: absolute-rfc3339,
                                             absolute-datetime, absolute-unix-seconds, absolute-unix-milliseconds, absolute-unix-microseconds,
                                             absolute-unix-nanoseconds, relative-nanoseconds, relative-microseconds, relative-milliseconds,
                                             relative-seconds, relative-minutes, relative-hours]
  -s <RELATIVE_START_TIME>                   Start time (RFC3339) to use if time format is relative
  -w, --wait                                 Wait until the import finishes processing
  -p, --preview                              Preview the parsed schema without uploading
  -h, --help                                 Print help (see more with '--help')

A parquet file where every column is exclusive to a single channel except for the time column

Usage: sift_cli import parquet flat-dataset [OPTIONS] --asset <ASSET> <PATH>

Arguments:
  <PATH>  Path to the Parquet file to import

Options:
  -a, --asset <ASSET>                            Name of the asset this data belongs to
  -r, --run <RUN>                                Optional run name to associate with this import
  -c, --channel-path <CHANNEL_PATH>              Paths of data columns to import; can be specified multiple times
      --profile <PROFILE>                        The profile to use
  -d, --data-type <DATA_TYPE>                    Data type for each channel in `--channel-path`. Use `"infer"` to have the program infer the data type
                                                 which is useful when wanting to just specify `--unit` and/or `--description` [possible values: infer,
                                                 double, string, enum, bit-field, bool, float, int32, uint32, int64, uint64, bytes]
      --disable-tls                              Disable TLS for non-cloud Sift environments
  -u, --unit <UNIT>                              Unit for each channel in `--channel-path` (can be empty)
  -n, --description <DESCRIPTION>                Description for each channel in `--channel-path` (can be empty)
  -e, --enum-config <ENUM_CONFIG>                Enum configuration pairs `<key,name>` for enum-type channels
  -b, --bit-field-config <BIT_FIELD_CONFIG>      Bit-field configuration triplets `<index,name,bit_count>` for bit-field channels
  -t, --time-path <TIME_PATH>                    Path to the time column [default: timestamp]
  -f, --time-format <TIME_FORMAT>                Time format used in the file [default: absolute-rfc3339] [possible values: absolute-rfc3339,
                                                 absolute-datetime, absolute-unix-seconds, absolute-unix-milliseconds, absolute-unix-microseconds,
                                                 absolute-unix-nanoseconds, relative-nanoseconds, relative-microseconds, relative-milliseconds,
                                                 relative-seconds, relative-minutes, relative-hours]
  -s <RELATIVE_START_TIME>                       Start time (RFC3339) to use if time format is relative
  -m, --complex-types-mode <COMPLEX_TYPES_MODE>  Strategy for handling complex types (maps, lists, structs) [default: ignore] [possible values: ignore,
                                                 both, string, bytes]
  -w, --wait                                     Wait until the import finishes processing
  -p, --preview                                  Preview the parsed schema without uploading
  -h, --help                                     Print help (see more with '--help')